/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.basics.bean;

import java.util.Collection;
import java.util.Enumeration;
import java.util.Iterator;

/**
 * This class allow to transform a <code>Iterator</code> to an
 * <code>Enumeration</code>.
 * 
 * @param <TYPE>
 *          the type of the elements of the <code>Enumeration</code>
 */
public class EnumerationIterator<TYPE>
    implements Enumeration<TYPE>
{

  /**
   * the <code>Iterator</code> wrapped.
   */
  private transient final Iterator<TYPE> iterator;



  /**
   * Constructor.
   * 
   * @param iterator
   *          the <code>Iterator</code> wrapped
   */
  public EnumerationIterator(final Iterator<TYPE> iterator)
  {
    this.iterator = iterator;
  }



  /**
   * Constructor.
   * 
   * @param collection
   *          the <code>Collection</code> that will be passed through.
   */
  public EnumerationIterator(final Collection<TYPE> collection)
  {
    this(collection.iterator());
  }



  /**
   * Tests if this enumeration contains more elements.
   * 
   * @return <code>true</code> if and only if this enumeration object contains
   *         at least one more element to provide; <code>false</code>
   *         otherwise.
   * @see java.util.Enumeration#hasMoreElements()
   */
  public boolean hasMoreElements()
  {
    return iterator.hasNext();
  }



  /**
   * Returns the next element of this enumeration if this enumeration object has
   * at least one more element to provide.
   * 
   * @return the next element of this enumeration
   * @see java.util.Enumeration#nextElement()
   */
  public TYPE nextElement()
  {
    return iterator.next();
  }

}
